home *** CD-ROM | disk | FTP | other *** search
/ Broadway Series Interactive Yearbook 2000 - 2001 / Broadway Series Interactive Yearbook 2000 - 2001.iso / mac / xtras / Effector Set I.x32 / MDESCRIBE / 102 next >
Text File  |  2000-02-25  |  5KB  |  142 lines
  1. Rotate Effect
  2. ___________________ Version 1.0,   Effector Set I  (v1.0)
  3. ___________________ Media Lab Xtras  
  4. ___________________  copyright 1997,  As Is Software, Inc.
  5.  
  6. Effect Symbol:       #rotate
  7.  
  8. _Properties______________Type______Value___
  9.  #animMode               symbol    #static, #range, #infinite, #pendulum,  #relativeToPoint    
  10.  #numFrames              integer   1+    
  11.  #framesPerRevolution    integer   0 not allowed,  negative means rotate counterclockwise, #infinite only
  12.  #interpolation          integer   0, 1, 2 
  13.  #degrees                integer   positive values are clockwise  
  14.  #radians                integer   positive values are clockwise  
  15.  #startDegrees           integer        
  16.  #startRadians           integer        
  17.  #endDegrees             integer        
  18.  #endRadians             integer        
  19.  #deltaDegrees           integer   positive values are clockwise    
  20.  #deltaRadians           integer   positive values are clockwise    
  21.  #flip                   integer   true or false    
  22.  #relativeTo             point     stage coordinates, valid in RelToPoint mode only  
  23.  #relativeToX            integer            
  24.  #relativeToY            integer            
  25.  #offsetAngle            integer   valid in RelToPoint mode only
  26.  #offsetAngleRad         integer   
  27.  #easeIn                 integer   frames    
  28.  #easeOut                integer   frames    
  29.  
  30.   
  31. Parameters by Mode
  32.  
  33. All Modes: 
  34.  interpolation
  35.  flip
  36.  
  37. Static:
  38.  degrees
  39.  radians
  40.  endDegrees
  41.  endRadians
  42.  deltaDegrees
  43.  deltaRadians
  44.  
  45. Range:
  46.  numFrames
  47.  degrees
  48.  radians
  49.  endDegrees
  50.  endRadians
  51.  deltaDegrees
  52.  deltaRadians
  53.  startDegrees
  54.  startRadians
  55.  easeIn
  56.  easeOut
  57.  
  58.      In #range mode the sprite will rotate to the endPosition from itÆs current (or start) position.  If the endPosition is a number greater than its starting position then the sprite will rotate clockwise.  If it is less than the starting position then it will rotate counter-clockwise.  No abbreviating occurs, so if the sprite is at 0 degrees and it is given an endPosition of 720 degrees then it will rotate three times clockwise.  ItÆs new starting position will be 720 degrees for the next call to range. 
  59.  
  60. Pendulum:
  61.  numFrames
  62.  degrees
  63.  radians
  64.  endDegrees
  65.  endRadians
  66.  deltaDegrees
  67.  deltaRadians
  68.  startDegrees
  69.  startRadians
  70.  easeIn
  71.  easeOut
  72.  
  73.        
  74. Infinite:
  75.  framesPerRevolution
  76.  startDegrees
  77.  startRadians
  78.  easeIn
  79.  
  80.    In #infinite mode the sprite will simply rotate forever.  A positive value for æframesPerRevolutionÆ will cause it to rotate clockwise, a negative value will cause it to rotate æcounter-clockwiseÆ.
  81.  
  82. RelativeToPoint:
  83.  relativeTo
  84.  relativeToX
  85.  relativeToY
  86.  offsetAngle
  87.  offsetAngleRad
  88.  
  89.      This is a custom mode for the rotate effect only.  In this mode, the sprite will always æfaceÆ the point at relativeToPoint, no matter where the sprite is on-screen. If desired, an offsetAngle argument can be provided.   
  90.  
  91.  
  92.  
  93. Custom Functions
  94.  
  95. RelToPoint
  96.   RelToPoint(sprite x, #rotate, xLocation, yLocation)
  97.   RelToPoint(sprite x, #rotate, xLocation, yLocation, offsetAngle)
  98.   RelToPoint(sprite x, #rotate, xLocation, yLocation, offsetAngle, flipFlag)
  99.   RelToPoint(sprite x, #rotate, xLocation, yLocation, offsetAngle, flipFlag, interpolation)
  100.      This is the mode accessor function for the #relativeToPoint mode.
  101.  
  102. InterpolateNow
  103.   InterpolateNow( sprite x, #rotate)
  104.      This function causes the sprite to immediately redraw interpolated, but does not change the flag for the sprites overall interpolation setting.
  105.  
  106. SetInterpolation
  107.   SetInterpolation(sprite x, #rotate, interpolation)
  108.  
  109. UseRadians
  110.   UseRadians(sprite x, #rotate, true / false)
  111.      Calling this function will make the sprite treat all subsequent function calls as if their degree arguments are in radians rather than degrees.  Call this function with a æfalseÆ argument to reset the sprite to regular degree usage.
  112.  
  113. Flip
  114.   Flip(sprite x, #rotate)
  115.   Flip(sprite x, #rotate, flipFlag)
  116.      If this function is called without the flipFlag argument, then the sprite will have itÆs flip state toggled.  When the flipFlag argument is used, then the sprite will have its flip state set.
  117.  
  118. GetAngle
  119.   GetAngle(sprite x, #rotate)
  120.      This argument will return the current angle of the sprite.  
  121.  
  122. GetVector
  123.   GetVector(sprite x, #rotate, distance)
  124.   GetVector(sprite x, #rotate, distance, degrees)
  125.      This function converts a distance and an angle into the sub vectors X and Y.  This function returns a point with the X and Y vectors in the x and y positions.  If no angle is provided, the current angle of the sprite is used.
  126.  
  127. GetRotatedRect
  128.   GetRotatedRect(sprite x, #rotate)
  129.   GetRotatedRect(sprite x, #rotate, degrees)
  130.   GetRotatedRect(sprite x, #rotate, degrees, rect)
  131.      This function takes a rect and an angle and calculates the new containing rect.  If no angle is provided it uses the sprites current angle, and if no rect is provided it uses the rect of the castmember at the spriteÆs location.
  132.  
  133. IsPointInRotatedRect
  134.   IsPointInRotatedRect(sprite x, #rotate, point)
  135.   IsPointInRotatedRect(sprite x, #rotate, point, degrees)
  136.   IsPointInRotatedRect(sprite x, #rotate, point, degrees, rect)
  137. This function returns true or false if a point is in the rotated rectangle of the sprite.  The current rectangle and angle of the sprite are used as defaults, but if desired the user can pass in custom arguments.
  138.  
  139.  
  140. Technical Support E-mail:  xtra-help@medialab.com
  141.  
  142.      www.medialab.com